home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 17 / CU Amiga Magazine's Super CD-ROM 17 (1997)(EMAP Images)(GB)[!][issue 1997-12].iso / CUCD / Programming / MUI / MCC_TimeString / Docs / English / TimeString_mcc.doc < prev    next >
Encoding:
Text File  |  1997-10-07  |  17.9 KB  |  582 lines
  1.  
  2.                       Table of Contents
  3.  
  4.   Copyright                   - Copyright information
  5.   Distribution                - Copying conditions
  6.   Disclaimer                  - Legal Information
  7.   Trademark                   - Trademark information
  8.   Support/Updates             - How to get updates and support
  9.   Author                      - How to reach the author
  10.  
  11.   Description                 - What is TimeString.mcc?
  12.   Requirements                - Requirements for using TimeString.mcc
  13.  
  14.   Installation                - How to install TimeString.mcc
  15.   Beta testers                - Installation information for beta testers
  16.  
  17.   Developer Info              - Information for developers
  18.  
  19.   History                     - Revision history of TimeString.mcc
  20.   Todo                        - Todo list
  21.   Known problems              - List of known problems
  22.   Acknowledgments             - Acknowledgments
  23.   Please rate                 - Please rate TimeString.mcc
  24.   Software                    - Software that uses TimeString.mcc
  25.  
  26.  
  27.  
  28. Copyright
  29. ---------
  30.  
  31. This software and its documentation are copyright 1996-1997 by Kai Hofmann. All
  32. rights reserved!
  33.  
  34. - Permission for COMMERCIAL USE is only given by an extra available commercial
  35.   license that must be validated!
  36.   Contact me directly for this license, because it will be individually handed
  37.   out per your needs!
  38.  
  39. - Permission is hereby granted, without written agreement and without license,
  40.   to USE this software and its documentation for any NON-COMMERCIAL purpose,
  41.   provided that the above copyright notice and the following paragraph appear
  42.   in all copies of this software (Non-commercial includes Giftware!).
  43.  
  44.   Please send me a full version of your product at no cost including free
  45.   updates!
  46.   Extra money is welcome (For Bank Account see author - but *ONLY* send in DM
  47.   to this Bank Account!).
  48.  
  49.  
  50.  
  51. Distribution
  52. ------------
  53.  
  54. Permission is hereby granted, without written agreement and without license
  55. or royalty fees, to copy and distribute this software and its documentation
  56. for any purpose, provided that the above copyright notice and the following
  57. paragraphs appear in all copies of this software, to:
  58.  
  59. - All who will distribute this software for free!
  60. - All free accessible INTERNET servers!
  61. - All Aminet® sites
  62. - Fred Fish for his great Amiga-Software-Library
  63. - The German SAAR AG PD-Library
  64. - Angela Schmidt's Meeting Pearls series
  65. - All others who do NOT take more than US$ 5.- for one disk that includes this
  66.   software!
  67.  
  68.  
  69.  
  70. IMPORTANT NOTE:
  71.  
  72. This package may not be included on any further Aminet CD-ROMs unless authors
  73. contributing their software to the CD-ROM, (without mentioning distribution
  74. "NoCD") are granted a copy of the CD *completely* *free* *of* *charge*.
  75.  
  76. The Meeting Pearls IV CD-ROM demonstrates that a Freebie policy is also
  77. possible with "very-low-budget" CD-ROMs (*), so Aminet should quickly
  78. re-establish the same Freebie policy it used up to Aminet CD 13.
  79.  
  80. (*) Suggested retail price for MP4 is DM 14,95/US$ 12/£ 8.95.
  81.  
  82.  
  83.  
  84. DISCLAIMER
  85. ----------
  86.  
  87. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  88. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  89. PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  90. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  91. OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
  92. TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
  93. PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
  94. CORRECTION.
  95.  
  96. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  97. ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM AS
  98. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  99. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
  100. USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
  101. RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE
  102. OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
  103. OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  104.  
  105. THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  106. ENHANCEMENTS, OR MODIFICATIONS.
  107.  
  108.  
  109.  
  110. Trademark
  111. ---------
  112.  
  113. DateLib is a trademark of Kai Hofmann.
  114.  
  115. Amiga, AmigaDOS and Workbench are registered trademarks of Amiga International,
  116. Inc.
  117. Aminet is a registered trademark of Stefan Ossowskis Schatztruhe GmbH
  118. SAS/C is a registered trademark of SAS Institute Inc.
  119.  
  120. All other trademarked names used herein are used for the purposes of
  121. identification and for the benefit of the trademark holder. No infringement
  122. of trademarks is intended. Trademarks remain the property of the trademark
  123. holder.
  124.  
  125.  
  126.  
  127. Support/Updates
  128. ---------------
  129.  
  130. - Updates will be available via Aminet®
  131. - Support will be available via the authors email address and via
  132.   http://home.pages.de/~i07m/amiga/mui/TimeString.html
  133.  
  134.  
  135.  
  136. Author
  137. ------
  138.  
  139. Kai Hofmann
  140. Arberger Heerstraße 92
  141. 28307 Bremen
  142. Germany
  143.  
  144. Phone: (+49)-(0)421/480780
  145. EMail: i07m@informatik.uni-bremen.de
  146.        i07m@zfn.uni-bremen.de
  147. IRC  : PowerStat@#AmigaGer
  148. WWW  : http://home.pages.de/~i07m/
  149.  
  150. Bank account : 1203 7503
  151. Account owner: Kai Hofmann
  152. Bank code    : 290 501 01
  153. Bank name    : Sparkasse in Bremen/Germany
  154.  
  155.  
  156.  
  157. Description
  158. -----------
  159.  
  160. TimeString is a Custom Class of the Magic User Interface © by Stefan Stuntz.
  161. It's a subclass of string-class and time-class.
  162.  
  163. The idea of this class was born during developing my Gregor application.
  164.  
  165. MUI public custom class that displaying a string gadget for time strings. The
  166. display format of the time string can be freely defined. An input string can be
  167. parsed by the given format string, or in various standard formates (see below).
  168.  
  169. TimeString.mcc features that are of interest for users:
  170. - Can be dragged around
  171. - Accepts drops of other Time.mcc objects and time-strings
  172. - Handles daylight savings time
  173. - Handles time zones
  174. - Supports 12h and 24h clocks
  175. - Supports various string formats
  176.  
  177. TimeString.mcc features of interest for developers:
  178. - Based on Time.mcc
  179. - Supports MUIM_Import and MUIM_Export
  180. - The time can be read in hour/minutes/seconds format or as seconds from
  181.   midnight on
  182. - The time range can be restricted - so the user can only input time that
  183.   lies within his/her working time
  184. - It's possible to notify a Date.mcc object when the next or previous day
  185.   was reached
  186. - Method to set the current time
  187. - Methods for increasing and decreasing the time
  188. - Method to compare with another time object
  189.  
  190. The display format for a TimeString object can be defined by the following
  191. (locale.library compatible) formatting codes:
  192.  
  193.   %q - hour using 24-hour style
  194.   %Q - hour using 12-hour style
  195.   %H - hour using 24-hour style with leading 0s
  196.   %I - hour using 12-hour style with leading 0s
  197.   %p - AM or PM strings
  198.   %M - the number of minutes with leading 0s
  199.   %S - number of seconds with leadings 0s
  200.   %r - same as "%I:%M:%S %p"
  201.   %R - same as "%H:%M"
  202.   %T - same as "%H:%M:%S"
  203.   %X - same as "%H:%M:%S"
  204.  
  205. You can also use the following formatting codes:
  206.  
  207.   %Th1f  - hour using 12h style with leading 0s
  208.   %Th1v  - hour using 12h style without leading 0s
  209.   %Th2f  - hour using 24h style with leading 0s
  210.   %Th2v  - hour using 24h style without leading 0s
  211.   %Tpso  - a/p
  212.   %Tpsu  - A/P
  213.   %Tplo  - am/pm
  214.   %Tplu  - AM/PM
  215.   %Tmf   - minute with leading 0s
  216.   %Tmv   - minute without leading 0s
  217.   %Tsf   - second with leading 0s
  218.   %Tsv   - second without leading 0s
  219.   %Tj.   - jd time starting with '.'
  220.   %Tj,   - jd time starting with ','
  221.   %Tj0   - jd time starting with '0.'
  222.   %Tj1   - jd time starting with '0,'
  223.  
  224.   %Tzh?? - hours only
  225.   %Tzm?  - 0100 (always with leading 0s)
  226.   %TzM?? - 01:00
  227.   %Tz?z? - Use Z   for UTC/GMT
  228.   %Tz?0? - Use +00 for UTC/GMT
  229.   %Tz??f - use leading 0s
  230.   %Tz??v - do not use leading 0s
  231.  
  232.   %Tc1   - Use DST for summer->winter change hour
  233.   %Tc2   - Use I/II for summer->winter change hour
  234.   %Tc3   - Use a/b for summer->winter change hour (24h only) - on 12h
  235.            falls back to 2
  236.  
  237. The parser can always parse the following formats:
  238.  
  239. H : hour (12h or 24h style)
  240. M : minute
  241. S : second
  242.  
  243. H
  244. H am/pm
  245.  
  246. HM
  247. H:M
  248. H.M
  249. H M
  250. HhM
  251. HhMm
  252. H:M am/pm
  253.  
  254. HMS
  255. H:M:S
  256. H.M.S
  257. H M S
  258. HhMmS
  259. HhMmSs
  260. H:M:S am/pm
  261.  
  262. jd - Julian time format '.5' = 12:00:00, '.75' = 18:00:00, etc.
  263.  
  264. You can also add the following information:
  265.  
  266. Z      - UTC/GMT Timezone
  267. +00    - Timezone
  268. -0000  - Timezone
  269. +00:00 - Timezone
  270.  
  271. DST - Daylight savings time
  272. I   - Daylight saving hour during the summer->winter switch
  273. II  - Normal hour during the summer->winter switch
  274. a   - Daylight saving hour during the summer->winter switch
  275. b   - Normal hour during the summer->winter switch
  276.  
  277.  
  278.  
  279. Requirements
  280. ------------
  281.  
  282. - MUI 3.1 (Version 12)
  283. - date.library
  284. - locale.library
  285.  
  286. - To use the Greek MCC-Install script you need the
  287.   "Greek Workbench" © AC Software
  288.  
  289. - To use the Russian MCC-Install script you need
  290.   "Rusifier" © Dmitry Mikhilov
  291.  
  292.  
  293.  
  294. Installation
  295. ------------
  296.  
  297. Only use the installer script!
  298. (The Installer must be in your system-path!)
  299.  
  300. If you use an Installer prior to V42 you should set the LANGUAGE Tooltype to
  301. your language. Installer V42 and better automatically use your current locale.
  302.  
  303.  
  304. Please note that the installer-script is very special, because:
  305.  
  306. - It features uninstallation
  307. - It is automated
  308. - It is very flexible
  309. - It is very intelligent (for an installer-script ;-)
  310. - It uses WrapGuide (if present) for the AmigaGuide®
  311.   documentation if running under a pre V39 system.
  312. - It can be reused by (hopefully) all other MUI custom classes, because the
  313.   authors of custom classes need to only change a few things:
  314.  
  315.   * The #copyright variable
  316.   * The #min_os_version and #min_os_revision variables
  317.   * The #min_mui_version and #min_mui_revision variables
  318.   * The #language_mcc and #language_mcc variables
  319.   * The P_CustomExists, P_CustomInstall and P_CustomUninstall procedures
  320.   * The 'APPNAME' tooltype within the MCC-Install icon.
  321.  
  322.  
  323.  
  324. Beta testers
  325. ------------
  326.  
  327. Version numbers of beta release will not change, so you must uninstall an
  328. earlier installed beta version before you can install a newer one!
  329.  
  330.  
  331.  
  332. Information for Developers
  333. --------------------------
  334.  
  335. There is no multiple inheritance for Boopsi/MUI for the moment, so we haven't
  336. any chance to create a real Time basis-class. But there is another way to have
  337. the same result (compatibility for all classes that are dealing with time).
  338. The solution is called interface inheritance like it was done with IDL for
  339. CORBA.
  340. TimeString.mcc inherits the interface from Time.mcc!
  341.  
  342.  
  343. Btw. it would be wise to use a
  344.  
  345.  SetAttrs(obj,
  346.             MUIA_Time_Hour, hour,
  347.             MUIA_Time_Min,  min,
  348.             MUIA_Time_Sec,  sec,
  349.           TAG_DONE
  350.          );
  351.  
  352. instead of single set()'s.
  353.  
  354.  
  355. - The following attributes are filtered out, so that they can't bring
  356.   a TimeString object into trouble:
  357.   MUIA_String_Contents, MUIA_String_Accept, MUIA_String_EditHook,
  358.   MUIA_String_Integer, MUIA_String_LonelyEditHook, MUIA_String_Secret,
  359.   MUIA_String_Reject, MUIA_FillArea
  360.  
  361. - When MUIA_ObjectID is defined a TimeString object will load/save the
  362.   following data during MUIM_Application_Load/MUIM_Application_Save
  363.   Hour, Min, Sec, Time Zone, DaylightSaving status
  364.  
  365.  
  366.  
  367. History
  368. -------
  369.  
  370. 14.10.1996 -    First release on Aminet
  371.         * Implementing MUIM_Import, MUIM_Export
  372.         * Demo updated
  373.         * Using MUIV_Font_Button for buttons
  374.         * Own parser for time strings
  375.                 * %% is no longer supported
  376. 10.02.1997 -    Second release on Aminet
  377.         * Now based on Time.mcc
  378.         * Improved demo
  379.         * Adding great icons from Eric Gerard
  380.         * Improved formatter
  381.         * Improved parser
  382.         * Fixed Assembler interface
  383.         * Fixed Modula interface
  384.         * Fixed Amiga-E interface
  385.         * Fixed Oberon interface
  386.         * Now needs date.library 33.230
  387. 14.03.1997 -    Third release on Aminet
  388.         * Now based on Time.mcc 12.2
  389.         * Demo updated
  390.             * Added Blitz Basic 2 interface
  391.             * Added Cluster interface
  392.             * Added ARexx interface
  393.             * Added MUIBuilder3 description
  394.             * Added German documentation
  395. 14.08.1997 -    Fourth release on Aminet
  396.         * Added AmigaGuide® V40 features to the documentation
  397.         * Added "Please rate" section to the documentation
  398.         * Added MagicWB readme
  399.         * Compiled with MCCLib 12.2
  400.         * MCC-Install 43.21
  401.         * Now needs date.library 33.278
  402.         * Now based on Time.mcc 12.3
  403.         * MUIA_String_Contents will now be filtered
  404.         * Improved Demo
  405. 07.10.1997 -    Fifth release on Aminet
  406.         * Now based on Time.mcc 12.4
  407.         * Improved demo
  408.         * Compiled with MCCLib 12.4
  409.  
  410.  
  411.  
  412. Todo
  413. ----
  414.  
  415. - BubbleHelp error text
  416. - Accept string by pressing Tab
  417.  
  418.  
  419.  
  420. Known problems
  421. --------------
  422.  
  423. - I heard that using 'test' and then 'cancel' the test settings within the
  424.   MUI preference manager will not work as expected when in using your MUI
  425.   classes within Libs:MUI/ instead of MUI:Libs/MUI/ !!!
  426.  
  427. - Old versions of the program called 'PhoneCost' written by André Schenk
  428.   <schenkae@tick.informatik.uni-stuttgart.de> installed another
  429.   'date.library' into 'Libs:'.
  430.  
  431.  
  432.  
  433. Acknowledgments are going to the following people:
  434.  
  435. Rita Reichl         : for correcting my English and being my inspiration
  436.  
  437. James Cooper,
  438. Steve Krueger,
  439. Doug Walker         : For supporting SAS/C® after SAS suspends the support.
  440.  
  441. Stefan Stuntz       : for the Magic User Interface and for his support
  442. Klaus Melchior      : for the MUI custom class support
  443. Martin Huttenloher  : for MagicWB
  444. Udo Schuermann      : for WrapGuide
  445. Stefan Kost         : for ag2txt
  446. Jürgen Kohrmeyer    : for the rexxtricks.library
  447.  
  448. Henning Thielemann  : for help with the Cluster interface
  449. Eric Gerard         : for his great icons
  450.  
  451.  
  452. Please rate
  453. -----------
  454.  
  455. Please rate TimeString.mcc and MCC-Install. To do so, send an email to
  456. aminet-server@wuarchive.wustl.edu
  457. with the following content:
  458.  
  459. RATE dev/mui/MCC-Install.lha <num>
  460. RATE dev/mui/MCC_TimeString.lha <num>
  461.  
  462. where <num> is a mark from 0..10 with 10 being the best.
  463. You can rate several programs in one mail.
  464.  
  465. Thank you!
  466.  
  467.  
  468.  
  469. Software
  470. --------
  471.  
  472. The following software products use TimeString.mcc:
  473.  
  474.  
  475.  
  476.  
  477.                       This is a custom class of the
  478.  
  479.  
  480.                         MUI - MagicUserInterface
  481.  
  482.                  Copyright © 1993-1997 by Stefan Stuntz
  483.  
  484.  
  485. MUI is a system to generate and maintain graphical user interfaces. With
  486. the  aid  of  a  preferences program, the user of an application has the
  487. ability to customize the outfit according to his personal taste.
  488.  
  489. MUI is distributed as shareware. To obtain a complete package containing
  490. lots of examples and more information about registration please look for
  491. a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  492. your local bulletin boards or on public domain disks.
  493.  
  494.           If you want to register directly, feel free to send
  495.  
  496.  
  497.                          DM 30.-  or  US$ 20.-
  498.  
  499.                                   to
  500.  
  501.                              Stefan Stuntz
  502.                         Eduard-Spranger-Straße 7
  503.                              80935 München
  504.                                 GERMANY
  505.  
  506.  
  507.              Support and online registration are available at
  508.  
  509.                           http://www.sasg.com/
  510.  
  511.  
  512.  
  513.                  This product is based on or uses parts of
  514.  
  515.                      MagicWB - The Workbench Enhancer
  516.                      --------------------------------
  517.  
  518.                  Copyright © 1992-1997, Martin Huttenloher
  519.  
  520. If  you  use  and like this product you should very much consider to take a
  521. look  at  MagicWB,  which  is the authentic source of the style, colors and
  522. design  elements  contained  in  this  package.   It  features  hundreds of
  523. original  icons,  patterns, image-drawers,  dock-brushes and some specially
  524. designed  high-quality  fonts  to  improve the comfort & legibility of your
  525. daily Workbench session.
  526.  
  527. What  is  MagicWB?   MagicWB  is  a full replacement for the Graphical User
  528. Interface  of the Workbench and has become the standard visual interface on
  529. the  Amiga.  Over the last years MagicWB has received various merits and an
  530. overwhelming  response from Amiga magazines and users worldwide proclaiming
  531. it  "a  must  for  all  Amiga  users".   Even  commercial  applications are
  532. supporting the multi-colored look & style of MagicWB.
  533.  
  534. Get yourself the latest version of MagicWB and see for yourself the wonders
  535. it  can  do by automatically transforming your old and dull Amiga Workbench
  536. into  an impressive workstation environment that will be the envy of all PC
  537. Windows  and  Mac users.  Update yourself to the state-of-the-art workbench
  538. standard  everyone uses on the Amiga!  It is also your key to enjoy the new
  539. look & feel of many applications and other MWB add-ons and extensions.
  540.  
  541. MagicWB  is  distributed as shareware.  Get yourself the latest FREE PUBLIC
  542. RELEASE of MagicWB now:  It is called
  543.  
  544.                              ----------------
  545.                               MagicWB21p.lha
  546.                              ----------------
  547.  
  548. and  can  be found everywhere on Aminet (or your local BBS or public domain
  549. series).   Install it and witness the instant magic it performs on your old
  550. Amiga  Workbench.   Also  included  is the latest SASG registration program
  551. with which you can order and get the full registered version of MagicWB.
  552.  
  553.              If you want to order directly, feel free to send
  554.  
  555.                   DM 30.- or US$ 20.- (cash, no checks!)
  556.  
  557.                                     to
  558.  
  559.                             Martin Huttenloher
  560.                              Am Hochstraess 4
  561.                                D-89081 Ulm
  562.                                  Germany
  563.  
  564. You  may  also  choose  to visit the official MagicWB homepage on the world
  565. wide  web.   There you can find the latest news & support and even register
  566. your  MagicWB  online  (which is much more comfortable and faster). You can
  567. even  benefit  from  various  special offers & discounts for MagicWB if you
  568. order through our website!  Come and visit MagicWB at:
  569.  
  570.                           ----------------------
  571.                            http://www.sasg.com/
  572.                           ----------------------
  573.  
  574.               Save 20% by using the discounts on our website!
  575.  
  576.            Ordering online also saves you a lot of time and work!
  577.  
  578.  
  579.  
  580. WrapGuide is Copyright 1994-1995 Udo Schuermann
  581. All rights reserved
  582.